<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>DB xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/apache/torque/adapter/DB.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <strong>package</strong> <a href="../../../../org/apache/torque/adapter/package-summary.html">org.apache.torque.adapter</a>;
<a name="2" href="#2">2</a>   
<a name="3" href="#3">3</a>   <em class="comment">/*</em>
<a name="4" href="#4">4</a>   <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="5" href="#5">5</a>   <em class="comment"> * or more contributor license agreements.  See the NOTICE file</em>
<a name="6" href="#6">6</a>   <em class="comment"> * distributed with this work for additional information</em>
<a name="7" href="#7">7</a>   <em class="comment"> * regarding copyright ownership.  The ASF licenses this file</em>
<a name="8" href="#8">8</a>   <em class="comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="9" href="#9">9</a>   <em class="comment"> * "License"); you may not use this file except in compliance</em>
<a name="10" href="#10">10</a>  <em class="comment"> * with the License.  You may obtain a copy of the License at</em>
<a name="11" href="#11">11</a>  <em class="comment"> *</em>
<a name="12" href="#12">12</a>  <em class="comment"> *   <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="13" href="#13">13</a>  <em class="comment"> *</em>
<a name="14" href="#14">14</a>  <em class="comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="15" href="#15">15</a>  <em class="comment"> * software distributed under the License is distributed on an</em>
<a name="16" href="#16">16</a>  <em class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="17" href="#17">17</a>  <em class="comment"> * KIND, either express or implied.  See the License for the</em>
<a name="18" href="#18">18</a>  <em class="comment"> * specific language governing permissions and limitations</em>
<a name="19" href="#19">19</a>  <em class="comment"> * under the License.</em>
<a name="20" href="#20">20</a>  <em class="comment"> */</em>
<a name="21" href="#21">21</a>  
<a name="22" href="#22">22</a>  <strong>import</strong> java.io.Serializable;
<a name="23" href="#23">23</a>  <strong>import</strong> java.sql.Connection;
<a name="24" href="#24">24</a>  <strong>import</strong> java.sql.SQLException;
<a name="25" href="#25">25</a>  <strong>import</strong> java.util.Date;
<a name="26" href="#26">26</a>  
<a name="27" href="#27">27</a>  <strong>import</strong> org.apache.torque.TorqueException;
<a name="28" href="#28">28</a>  <strong>import</strong> org.apache.torque.util.Query;
<a name="29" href="#29">29</a>  
<a name="30" href="#30">30</a>  <em>/**<em>*</em></em>
<a name="31" href="#31">31</a>  <em> * &lt;code>DB&lt;/code> defines the interface for a Torque database</em>
<a name="32" href="#32">32</a>  <em> * adapter.  Support for new databases is added by implementing this</em>
<a name="33" href="#33">33</a>  <em> * interface. A couple of default settings is provided by</em>
<a name="34" href="#34">34</a>  <em> * subclassing &lt;code>AbstractDBAdapter&lt;/code>. The new database adapter</em>
<a name="35" href="#35">35</a>  <em> * and its corresponding JDBC driver need to be registered in the service</em>
<a name="36" href="#36">36</a>  <em> * configuration file.</em>
<a name="37" href="#37">37</a>  <em> *</em>
<a name="38" href="#38">38</a>  <em> * &lt;p>The Torque database adapters exist to present a uniform</em>
<a name="39" href="#39">39</a>  <em> * interface to database access across all available databases.  Once</em>
<a name="40" href="#40">40</a>  <em> * the necessary adapters have been written and configured,</em>
<a name="41" href="#41">41</a>  <em> * transparent swapping of databases is theoretically supported with</em>
<a name="42" href="#42">42</a>  <em> * &lt;i>zero code changes&lt;/i> and minimal configuration file</em>
<a name="43" href="#43">43</a>  <em> * modifications.</em>
<a name="44" href="#44">44</a>  <em> *</em>
<a name="45" href="#45">45</a>  <em> * All database adapters need to be thread safe, as they are instantiated</em>
<a name="46" href="#46">46</a>  <em> * only once fore a given configured database and may be accessed</em>
<a name="47" href="#47">47</a>  <em> * simultaneously from several threads.</em>
<a name="48" href="#48">48</a>  <em> *</em>
<a name="49" href="#49">49</a>  <em> * &lt;p>Torque uses the driver class name to find the right adapter.</em>
<a name="50" href="#50">50</a>  <em> * A JDBC driver corresponding to your adapter must be added to the properties</em>
<a name="51" href="#51">51</a>  <em> * file, using the fully-qualified class name of the driver. If no driver is</em>
<a name="52" href="#52">52</a>  <em> * specified for your database, &lt;code>driver.default&lt;/code> is used.</em>
<a name="53" href="#53">53</a>  <em> *</em>
<a name="54" href="#54">54</a>  <em> * &lt;pre></em>
<a name="55" href="#55">55</a>  <em> * #### MySQL MM Driver</em>
<a name="56" href="#56">56</a>  <em> * database.default.driver=org.gjt.mm.mysql.Driver</em>
<a name="57" href="#57">57</a>  <em> * database.default.url=jdbc:mysql://localhost/DATABASENAME</em>
<a name="58" href="#58">58</a>  <em> * &lt;/pre></em>
<a name="59" href="#59">59</a>  <em> *</em>
<a name="60" href="#60">60</a>  <em> * @author &lt;a href="<a href="mailto:jon@latchkey.com" target="alexandria_uri">mailto:jon@latchkey.com</a>">Jon S. Stevens&lt;/a></em>
<a name="61" href="#61">61</a>  <em> * @author &lt;a href="<a href="mailto:bmclaugh@algx.net" target="alexandria_uri">mailto:bmclaugh@algx.net</a>">Brett McLaughlin&lt;/a></em>
<a name="62" href="#62">62</a>  <em> * @author &lt;a href="<a href="mailto:dlr@finemaltcoding.com" target="alexandria_uri">mailto:dlr@finemaltcoding.com</a>">Daniel Rall&lt;/a></em>
<a name="63" href="#63">63</a>  <em> * @author &lt;a href="<a href="mailto:vido@ldh.org" target="alexandria_uri">mailto:vido@ldh.org</a>">Augustin Vidovic&lt;/a></em>
<a name="64" href="#64">64</a>  <em> * @author &lt;a href="<a href="mailto:tv@apache.org" target="alexandria_uri">mailto:tv@apache.org</a>">Thomas Vandahl&lt;/a></em>
<a name="65" href="#65">65</a>  <em> * @version $Id: DB.java 476550 2006-11-18 16:08:37Z tfischer $</em>
<a name="66" href="#66">66</a>  <em> */</em>
<a name="67" href="#67">67</a>  <strong>public</strong> <strong>interface</strong> <a href="../../../../org/apache/torque/adapter/DB.html">DB</a> <strong>extends</strong> Serializable, <a href="../../../../org/apache/torque/adapter/IDMethod.html">IDMethod</a>
<a name="68" href="#68">68</a>  {
<a name="69" href="#69">69</a>      <em>/**<em>* Database does not support limiting result sets.</em></em>
<a name="70" href="#70">70</a>  <em>     *  @deprecated This should not be exposed to the outside</em>
<a name="71" href="#71">71</a>  <em>     */</em>
<a name="72" href="#72">72</a>      <strong>int</strong> LIMIT_STYLE_NONE = 0;
<a name="73" href="#73">73</a>  
<a name="74" href="#74">74</a>      <em>/**<em>* &lt;code>SELECT ... LIMIT &lt;limit>, [&amp;lt;offset&amp;gt;]&lt;/code></em></em>
<a name="75" href="#75">75</a>  <em>     *  @deprecated This should not be exposed to the outside</em>
<a name="76" href="#76">76</a>  <em>     */</em>
<a name="77" href="#77">77</a>      <strong>int</strong> LIMIT_STYLE_POSTGRES = 1;
<a name="78" href="#78">78</a>  
<a name="79" href="#79">79</a>      <em>/**<em>* &lt;code>SELECT ... LIMIT [&lt;offset>, ] &amp;lt;offset&amp;gt;&lt;/code></em></em>
<a name="80" href="#80">80</a>  <em>     *  @deprecated This should not be exposed to the outside</em>
<a name="81" href="#81">81</a>  <em>     */</em>
<a name="82" href="#82">82</a>      <strong>int</strong> LIMIT_STYLE_MYSQL = 2;
<a name="83" href="#83">83</a>  
<a name="84" href="#84">84</a>      <em>/**<em>* &lt;code>SET ROWCOUNT &amp;lt;offset&amp;gt; SELECT ... SET ROWCOUNT 0&lt;/code></em></em>
<a name="85" href="#85">85</a>  <em>     *  @deprecated This should not be exposed to the outside</em>
<a name="86" href="#86">86</a>  <em>     */</em>
<a name="87" href="#87">87</a>      <strong>int</strong> LIMIT_STYLE_SYBASE = 3;
<a name="88" href="#88">88</a>  
<a name="89" href="#89">89</a>      <em>/**<em>* &lt;code>&lt;pre>SELECT ... WHERE ... AND ROWNUM &lt; &lt;limit>&lt;/pre>&lt;/code></em></em>
<a name="90" href="#90">90</a>  <em>     *  @deprecated This should not be exposed to the outside</em>
<a name="91" href="#91">91</a>  <em>     */</em>
<a name="92" href="#92">92</a>      <strong>int</strong> LIMIT_STYLE_ORACLE = 4;
<a name="93" href="#93">93</a>  
<a name="94" href="#94">94</a>      <em>/**<em>* &lt;code>&lt;pre>SELECT ... WHERE ... AND ROW_NUMBER() OVER() &lt; &lt;limit>&lt;/pre>&lt;/code></em></em>
<a name="95" href="#95">95</a>  <em>     *  @deprecated This should not be exposed to the outside</em>
<a name="96" href="#96">96</a>  <em>     */</em>
<a name="97" href="#97">97</a>      <strong>int</strong> LIMIT_STYLE_DB2 = 5;
<a name="98" href="#98">98</a>  
<a name="99" href="#99">99</a>      <em>/**<em>*</em></em>
<a name="100" href="#100">100</a> <em>     * Key for the configuration which contains database adapters.</em>
<a name="101" href="#101">101</a> <em>     */</em>
<a name="102" href="#102">102</a>     String ADAPTER_KEY = <span class="string">"adapter"</span>;
<a name="103" href="#103">103</a> 
<a name="104" href="#104">104</a>     <em>/**<em>*</em></em>
<a name="105" href="#105">105</a> <em>     * Key for the configuration which contains database drivers.</em>
<a name="106" href="#106">106</a> <em>     */</em>
<a name="107" href="#107">107</a>     String DRIVER_KEY = <span class="string">"driver"</span>;
<a name="108" href="#108">108</a> 
<a name="109" href="#109">109</a>     <em>/**<em>*</em></em>
<a name="110" href="#110">110</a> <em>     * This method is used to ignore case.</em>
<a name="111" href="#111">111</a> <em>     *</em>
<a name="112" href="#112">112</a> <em>     * @param in The string to transform to upper case.</em>
<a name="113" href="#113">113</a> <em>     * @return The upper case string.</em>
<a name="114" href="#114">114</a> <em>     */</em>
<a name="115" href="#115">115</a>     String toUpperCase(String in);
<a name="116" href="#116">116</a> 
<a name="117" href="#117">117</a>     <em>/**<em>*</em></em>
<a name="118" href="#118">118</a> <em>     * Returns the character used to indicate the beginning and end of</em>
<a name="119" href="#119">119</a> <em>     * a piece of text used in a SQL statement (generally a single</em>
<a name="120" href="#120">120</a> <em>     * quote).</em>
<a name="121" href="#121">121</a> <em>     *</em>
<a name="122" href="#122">122</a> <em>     * @return The text delimeter.</em>
<a name="123" href="#123">123</a> <em>     */</em>
<a name="124" href="#124">124</a>     <strong>char</strong> getStringDelimiter();
<a name="125" href="#125">125</a> 
<a name="126" href="#126">126</a>     <em>/**<em>*</em></em>
<a name="127" href="#127">127</a> <em>     * Returns the constant from the {@link</em>
<a name="128" href="#128">128</a> <em>     * org.apache.torque.adapter.IDMethod} interface denoting which</em>
<a name="129" href="#129">129</a> <em>     * type of primary key generation method this type of RDBMS uses.</em>
<a name="130" href="#130">130</a> <em>     *</em>
<a name="131" href="#131">131</a> <em>     * @return IDMethod constant</em>
<a name="132" href="#132">132</a> <em>     */</em>
<a name="133" href="#133">133</a>     String getIDMethodType();
<a name="134" href="#134">134</a> 
<a name="135" href="#135">135</a>     <em>/**<em>*</em></em>
<a name="136" href="#136">136</a> <em>     * Returns SQL used to get the most recently inserted primary key.</em>
<a name="137" href="#137">137</a> <em>     * Databases which have no support for this return</em>
<a name="138" href="#138">138</a> <em>     * &lt;code>null&lt;/code>.</em>
<a name="139" href="#139">139</a> <em>     *</em>
<a name="140" href="#140">140</a> <em>     * @param obj Information used for key generation.</em>
<a name="141" href="#141">141</a> <em>     * @return The most recently inserted database key.</em>
<a name="142" href="#142">142</a> <em>     */</em>
<a name="143" href="#143">143</a>     String getIDMethodSQL(Object obj);
<a name="144" href="#144">144</a> 
<a name="145" href="#145">145</a>     <em>/**<em>*</em></em>
<a name="146" href="#146">146</a> <em>     * Locks the specified table.</em>
<a name="147" href="#147">147</a> <em>     *</em>
<a name="148" href="#148">148</a> <em>     * @param con The JDBC connection to use.</em>
<a name="149" href="#149">149</a> <em>     * @param table The name of the table to lock.</em>
<a name="150" href="#150">150</a> <em>     * @throws SQLException No Statement could be created or executed.</em>
<a name="151" href="#151">151</a> <em>     */</em>
<a name="152" href="#152">152</a>     <strong>void</strong> lockTable(Connection con, String table)
<a name="153" href="#153">153</a>             throws SQLException;
<a name="154" href="#154">154</a> 
<a name="155" href="#155">155</a>     <em>/**<em>*</em></em>
<a name="156" href="#156">156</a> <em>     * Unlocks the specified table.</em>
<a name="157" href="#157">157</a> <em>     *</em>
<a name="158" href="#158">158</a> <em>     * @param con The JDBC connection to use.</em>
<a name="159" href="#159">159</a> <em>     * @param table The name of the table to unlock.</em>
<a name="160" href="#160">160</a> <em>     * @throws SQLException No Statement could be created or executed.</em>
<a name="161" href="#161">161</a> <em>     */</em>
<a name="162" href="#162">162</a>     <strong>void</strong> unlockTable(Connection con, String table)
<a name="163" href="#163">163</a>             throws SQLException;
<a name="164" href="#164">164</a> 
<a name="165" href="#165">165</a>     <em>/**<em>*</em></em>
<a name="166" href="#166">166</a> <em>     * Modifies a SQL snippet such that its case is ignored by the database.</em>
<a name="167" href="#167">167</a> <em>     * The SQL snippet can be a column name (like AURHOR.NAME), an</em>
<a name="168" href="#168">168</a> <em>     * quoted explicit sql string (like 'abc') or any other sql value (like a</em>
<a name="169" href="#169">169</a> <em>     * number etc.).</em>
<a name="170" href="#170">170</a> <em>     *</em>
<a name="171" href="#171">171</a> <em>     * @param in The SQL snippet whose case to ignore.</em>
<a name="172" href="#172">172</a> <em>     * @return The string in a case that can be ignored.</em>
<a name="173" href="#173">173</a> <em>     */</em>
<a name="174" href="#174">174</a>     String ignoreCase(String in);
<a name="175" href="#175">175</a> 
<a name="176" href="#176">176</a>     <em>/**<em>*</em></em>
<a name="177" href="#177">177</a> <em>     * This method is used to ignore case in an ORDER BY clause.</em>
<a name="178" href="#178">178</a> <em>     * Usually it is the same as ignoreCase, but some databases</em>
<a name="179" href="#179">179</a> <em>     * (Interbase for example) does not use the same SQL in ORDER BY</em>
<a name="180" href="#180">180</a> <em>     * and other clauses.</em>
<a name="181" href="#181">181</a> <em>     *</em>
<a name="182" href="#182">182</a> <em>     * @param in The string whose case to ignore.</em>
<a name="183" href="#183">183</a> <em>     * @return The string in a case that can be ignored.</em>
<a name="184" href="#184">184</a> <em>     */</em>
<a name="185" href="#185">185</a>     String ignoreCaseInOrderBy(String in);
<a name="186" href="#186">186</a> 
<a name="187" href="#187">187</a>     <em>/**<em>*</em></em>
<a name="188" href="#188">188</a> <em>     * This method is used to check whether the database natively</em>
<a name="189" href="#189">189</a> <em>     * supports limiting the size of the resultset.</em>
<a name="190" href="#190">190</a> <em>     *</em>
<a name="191" href="#191">191</a> <em>     * @return True if the database natively supports limiting the</em>
<a name="192" href="#192">192</a> <em>     * size of the resultset.</em>
<a name="193" href="#193">193</a> <em>     */</em>
<a name="194" href="#194">194</a>     <strong>boolean</strong> supportsNativeLimit();
<a name="195" href="#195">195</a> 
<a name="196" href="#196">196</a>     <em>/**<em>*</em></em>
<a name="197" href="#197">197</a> <em>     * This method is used to check whether the database natively</em>
<a name="198" href="#198">198</a> <em>     * supports returning results starting at an offset position other</em>
<a name="199" href="#199">199</a> <em>     * than 0.</em>
<a name="200" href="#200">200</a> <em>     *</em>
<a name="201" href="#201">201</a> <em>     * @return True if the database natively supports returning</em>
<a name="202" href="#202">202</a> <em>     * results starting at an offset position other than 0.</em>
<a name="203" href="#203">203</a> <em>     */</em>
<a name="204" href="#204">204</a>     <strong>boolean</strong> supportsNativeOffset();
<a name="205" href="#205">205</a> 
<a name="206" href="#206">206</a>     <em>/**<em>*</em></em>
<a name="207" href="#207">207</a> <em>     * This method is used to generate the database specific query</em>
<a name="208" href="#208">208</a> <em>     * extension to limit the number of record returned.</em>
<a name="209" href="#209">209</a> <em>     *</em>
<a name="210" href="#210">210</a> <em>     * @param query The query to modify</em>
<a name="211" href="#211">211</a> <em>     * @param offset the offset Value</em>
<a name="212" href="#212">212</a> <em>     * @param limit the limit Value</em>
<a name="213" href="#213">213</a> <em>     *</em>
<a name="214" href="#214">214</a> <em>     * @throws TorqueException if any error occurs when building the query</em>
<a name="215" href="#215">215</a> <em>     */</em>
<a name="216" href="#216">216</a>     <strong>void</strong> generateLimits(<a href="../../../../org/apache/torque/util/Query.html">Query</a> query, <strong>int</strong> offset, <strong>int</strong> limit)
<a name="217" href="#217">217</a>         throws TorqueException;
<a name="218" href="#218">218</a> 
<a name="219" href="#219">219</a>     <em>/**<em>*</em></em>
<a name="220" href="#220">220</a> <em>    * Whether backslashes (\) should be escaped in explicit SQL strings.</em>
<a name="221" href="#221">221</a> <em>    * If true is returned, a BACKSLASH will be changed to "&#47;&#47;". If false</em>
<a name="222" href="#222">222</a> <em>    * is returned, a BACKSLASH will be left as "\&quot;.</em>
<a name="223" href="#223">223</a> <em>    *</em>
<a name="224" href="#224">224</a> <em>    * @return true if the database needs to escape backslashes</em>
<a name="225" href="#225">225</a> <em>    *         in SqlExpressions.</em>
<a name="226" href="#226">226</a> <em>    */</em>
<a name="227" href="#227">227</a> 
<a name="228" href="#228">228</a>     <strong>boolean</strong> escapeText();
<a name="229" href="#229">229</a> 
<a name="230" href="#230">230</a>     <em>/**<em>*</em></em>
<a name="231" href="#231">231</a> <em>     * This method is used to check whether the database supports</em>
<a name="232" href="#232">232</a> <em>     * limiting the size of the resultset.</em>
<a name="233" href="#233">233</a> <em>     *</em>
<a name="234" href="#234">234</a> <em>     * @return The limit style for the database.</em>
<a name="235" href="#235">235</a> <em>     * @deprecated This should not be exposed to the outside</em>
<a name="236" href="#236">236</a> <em>     */</em>
<a name="237" href="#237">237</a>     <strong>int</strong> getLimitStyle();
<a name="238" href="#238">238</a> 
<a name="239" href="#239">239</a>     <em>/**<em>*</em></em>
<a name="240" href="#240">240</a> <em>     * This method is used to format any date string.</em>
<a name="241" href="#241">241</a> <em>     * Database can use different default date formats.</em>
<a name="242" href="#242">242</a> <em>     *</em>
<a name="243" href="#243">243</a> <em>     * @param date the Date to format</em>
<a name="244" href="#244">244</a> <em>     * @return The proper date formatted String.</em>
<a name="245" href="#245">245</a> <em>     */</em>
<a name="246" href="#246">246</a>     String getDateString(Date date);
<a name="247" href="#247">247</a> 
<a name="248" href="#248">248</a>     <em>/**<em>*</em></em>
<a name="249" href="#249">249</a> <em>     * This method is used to format a boolean string.</em>
<a name="250" href="#250">250</a> <em>     *</em>
<a name="251" href="#251">251</a> <em>     * @param b the Boolean to format</em>
<a name="252" href="#252">252</a> <em>     * @return The proper date formatted String.</em>
<a name="253" href="#253">253</a> <em>     */</em>
<a name="254" href="#254">254</a>     String getBooleanString(Boolean b);
<a name="255" href="#255">255</a> 
<a name="256" href="#256">256</a>     <em>/**<em>*</em></em>
<a name="257" href="#257">257</a> <em>     * Whether ILIKE should be used for case insensitive like clauses.</em>
<a name="258" href="#258">258</a> <em>     *</em>
<a name="259" href="#259">259</a> <em>     * @return true if ilike should be used for case insensitive likes,</em>
<a name="260" href="#260">260</a> <em>     *         false if ignoreCase should be applied to the compared strings.</em>
<a name="261" href="#261">261</a> <em>     */</em>
<a name="262" href="#262">262</a>     <strong>boolean</strong> useIlike();
<a name="263" href="#263">263</a> 
<a name="264" href="#264">264</a>     <em>/**<em>*</em></em>
<a name="265" href="#265">265</a> <em>     * Whether an escape clause in like should be used.</em>
<a name="266" href="#266">266</a> <em>     * Example : select * from AUTHOR where AUTHOR.NAME like '\_%' ESCAPE '\';</em>
<a name="267" href="#267">267</a> <em>     *</em>
<a name="268" href="#268">268</a> <em>     * @return whether the escape clause should be appended or not.</em>
<a name="269" href="#269">269</a> <em>     */</em>
<a name="270" href="#270">270</a>     <strong>boolean</strong> useEscapeClauseForLike();
<a name="271" href="#271">271</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

